sdmodulemgr module

class sd.api.sdmodulemgr.SDModuleMgr(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdapiobject.SDAPIObject

Keep track of all available SDModule. There is only one SDModuleMgr, that you can retrieve from the SDApplication

addRootPath(moduleIdPrefix: str, path: str) → None

Add a root path. For MDL, all MDL Modules (i.e. “.mdl” files) under this path will be added

Parameters

• moduleIdPrefix – The prefix used to specify which technology is concerned. Ex: “mdl”

• path – The path of the directory to add

getClassName() → str

Returns the most specific name of the class this APIObject is

getModuleFromId(sdModuleId: str) → Optional[sd.api.sdmodule.SDModule]

Get the SDModule that matches the specified identifier

Parameters

sdModuleId – The identifier of the SDModule to retrieve

getModules() → sd.api.sdarray.SDArray[sd.api.sdmodule.SDModule][sd.api.sdmodule.SDModule]

Get all available SDModule

getRootPaths(moduleIdPrefix: str) → sd.api.sdarray.SDArray[sd.api.sdvaluestring.SDValueString][sd.api.sdvaluestring.SDValueString]

Get all the root path registered

Parameters

moduleIdPrefix – The prefix used to specify which technology is concerned. Ex: “mdl”

release() → None

Releases an APIObject

removeRootPath(moduleIdPrefix: str, path: str) → None

Remove a root path

Parameters

• moduleIdPrefix – The prefix used to specify which technology is concerned. Ex: “mdl”

• path – The path of the directory to remove